home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / argp.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-05-08  |  25.8 KB  |  600 lines
  1. /* Hierarchial argument parsing, layered over getopt.
  2.    Copyright (C) 1995-1999,2003,2004 Free Software Foundation, Inc.
  3.    This file is part of the GNU C Library.
  4.    Written by Miles Bader <miles@gnu.ai.mit.edu>.
  5.  
  6.    The GNU C Library is free software; you can redistribute it and/or
  7.    modify it under the terms of the GNU Lesser General Public
  8.    License as published by the Free Software Foundation; either
  9.    version 2.1 of the License, or (at your option) any later version.
  10.  
  11.    The GNU C Library is distributed in the hope that it will be useful,
  12.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.    Lesser General Public License for more details.
  15.  
  16.    You should have received a copy of the GNU Lesser General Public
  17.    License along with the GNU C Library; if not, write to the Free
  18.    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19.    02111-1307 USA.  */
  20.  
  21. #ifndef _ARGP_H
  22. #define _ARGP_H
  23.  
  24. #include <stdio.h>
  25. #include <ctype.h>
  26. #include <getopt.h>
  27.  
  28. #define __need_error_t
  29. #include <errno.h>
  30.  
  31. #ifndef __const
  32. # define __const const
  33. #endif
  34.  
  35. #ifndef __THROW
  36. # define __THROW
  37. #endif
  38. #ifndef __NTH
  39. # define __NTH(fct) fct __THROW
  40. #endif
  41.  
  42. #ifndef __attribute__
  43. /* This feature is available in gcc versions 2.5 and later.  */
  44. # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
  45. #  define __attribute__(Spec) /* empty */
  46. # endif
  47. /* The __-protected variants of `format' and `printf' attributes
  48.    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
  49. # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__
  50. #  define __format__ format
  51. #  define __printf__ printf
  52. # endif
  53. #endif
  54.  
  55. /* GCC 2.95 and later have "__restrict"; C99 compilers have
  56.    "restrict", and "configure" may have defined "restrict".  */
  57. #ifndef __restrict
  58. # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
  59. #  if defined restrict || 199901L <= __STDC_VERSION__
  60. #   define __restrict restrict
  61. #  else
  62. #   define __restrict
  63. #  endif
  64. # endif
  65. #endif
  66.  
  67. #ifndef __error_t_defined
  68. typedef int error_t;
  69. # define __error_t_defined
  70. #endif
  71.  
  72. #ifdef  __cplusplus
  73. extern "C" {
  74. #endif
  75.  
  76. /* A description of a particular option.  A pointer to an array of
  77.    these is passed in the OPTIONS field of an argp structure.  Each option
  78.    entry can correspond to one long option and/or one short option; more
  79.    names for the same option can be added by following an entry in an option
  80.    array with options having the OPTION_ALIAS flag set.  */
  81. struct argp_option
  82. {
  83.   /* The long option name.  For more than one name for the same option, you
  84.      can use following options with the OPTION_ALIAS flag set.  */
  85.   __const char *name;
  86.  
  87.   /* What key is returned for this option.  If > 0 and printable, then it's
  88.      also accepted as a short option.  */
  89.   int key;
  90.  
  91.   /* If non-NULL, this is the name of the argument associated with this
  92.      option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */
  93.   __const char *arg;
  94.  
  95.   /* OPTION_ flags.  */
  96.   int flags;
  97.  
  98.   /* The doc string for this option.  If both NAME and KEY are 0, This string
  99.      will be printed outdented from the normal option column, making it
  100.      useful as a group header (it will be the first thing printed in its
  101.      group); in this usage, it's conventional to end the string with a `:'.  */
  102.   __const char *doc;
  103.  
  104.   /* The group this option is in.  In a long help message, options are sorted
  105.      alphabetically within each group, and the groups presented in the order
  106.      0, 1, 2, ..., n, -m, ..., -2, -1.  Every entry in an options array with
  107.      if this field 0 will inherit the group number of the previous entry, or
  108.      zero if it's the first one, unless its a group header (NAME and KEY both
  109.      0), in which case, the previous entry + 1 is the default.  Automagic
  110.      options such as --help are put into group -1.  */
  111.   int group;
  112. };
  113.  
  114. /* The argument associated with this option is optional.  */
  115. #define OPTION_ARG_OPTIONAL    0x1
  116.  
  117. /* This option isn't displayed in any help messages.  */
  118. #define OPTION_HIDDEN               0x2
  119.  
  120. /* This option is an alias for the closest previous non-alias option.  This
  121.    means that it will be displayed in the same help entry, and will inherit
  122.    fields other than NAME and KEY from the aliased option.  */
  123. #define OPTION_ALIAS        0x4
  124.  
  125. /* This option isn't actually an option (and so should be ignored by the
  126.    actual option parser), but rather an arbitrary piece of documentation that
  127.    should be displayed in much the same manner as the options.  If this flag
  128.    is set, then the option NAME field is displayed unmodified (e.g., no `--'
  129.    prefix is added) at the left-margin (where a *short* option would normally
  130.    be displayed), and the documentation string in the normal place.  For
  131.    purposes of sorting, any leading whitespace and punctuation is ignored,
  132.    except that if the first non-whitespace character is not `-', this entry
  133.    is displayed after all options (and OPTION_DOC entries with a leading `-')
  134.    in the same group.  */
  135. #define OPTION_DOC        0x8
  136.  
  137. /* This option shouldn't be included in `long' usage messages (but is still
  138.    included in help messages).  This is mainly intended for options that are
  139.    completely documented in an argp's ARGS_DOC field, in which case including
  140.    the option in the generic usage list would be redundant.  For instance,
  141.    if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to
  142.    distinguish these two cases, -x should probably be marked
  143.    OPTION_NO_USAGE.  */
  144. #define OPTION_NO_USAGE        0x10
  145.  
  146. struct argp;            /* fwd declare this type */
  147. struct argp_state;        /* " */
  148. struct argp_child;        /* " */
  149.  
  150. /* The type of a pointer to an argp parsing function.  */
  151. typedef error_t (*argp_parser_t) (int key, char *arg,
  152.                   struct argp_state *state);
  153.  
  154. /* What to return for unrecognized keys.  For special ARGP_KEY_ keys, such
  155.    returns will simply be ignored.  For user keys, this error will be turned
  156.    into EINVAL (if the call to argp_parse is such that errors are propagated
  157.    back to the user instead of exiting); returning EINVAL itself would result
  158.    in an immediate stop to parsing in *all* cases.  */
  159. #define ARGP_ERR_UNKNOWN    E2BIG /* Hurd should never need E2BIG.  XXX */
  160.  
  161. /* Special values for the KEY argument to an argument parsing function.
  162.    ARGP_ERR_UNKNOWN should be returned if they aren't understood.
  163.  
  164.    The sequence of keys to a parsing function is either (where each
  165.    uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key):
  166.  
  167.        INIT opt... NO_ARGS END SUCCESS  -- No non-option arguments at all
  168.    or  INIT (opt | ARG)... END SUCCESS  -- All non-option args parsed
  169.    or  INIT (opt | ARG)... SUCCESS      -- Some non-option arg unrecognized
  170.  
  171.    The third case is where every parser returned ARGP_KEY_UNKNOWN for an
  172.    argument, in which case parsing stops at that argument (returning the
  173.    unparsed arguments to the caller of argp_parse if requested, or stopping
  174.    with an error message if not).
  175.  
  176.    If an error occurs (either detected by argp, or because the parsing
  177.    function returned an error value), then the parser is called with
  178.    ARGP_KEY_ERROR, and no further calls are made.  */
  179.  
  180. /* This is not an option at all, but rather a command line argument.  If a
  181.    parser receiving this key returns success, the fact is recorded, and the
  182.    ARGP_KEY_NO_ARGS case won't be used.  HOWEVER, if while processing the
  183.    argument, a parser function decrements the NEXT field of the state it's
  184.    passed, the option won't be considered processed; this is to allow you to
  185.    actually modify the argument (perhaps into an option), and have it
  186.    processed again.  */
  187. #define ARGP_KEY_ARG        0
  188. /* There are remaining arguments not parsed by any parser, which may be found
  189.    starting at (STATE->argv + STATE->next).  If success is returned, but
  190.    STATE->next left untouched, it's assumed that all arguments were consume,
  191.    otherwise, the parser should adjust STATE->next to reflect any arguments
  192.    consumed.  */
  193. #define ARGP_KEY_ARGS        0x1000006
  194. /* There are no more command line arguments at all.  */
  195. #define ARGP_KEY_END        0x1000001
  196. /* Because it's common to want to do some special processing if there aren't
  197.    any non-option args, user parsers are called with this key if they didn't
  198.    successfully process any non-option arguments.  Called just before
  199.    ARGP_KEY_END (where more general validity checks on previously parsed
  200.    arguments can take place).  */
  201. #define ARGP_KEY_NO_ARGS    0x1000002
  202. /* Passed in before any parsing is done.  Afterwards, the values of each
  203.    element of the CHILD_INPUT field, if any, in the state structure is
  204.    copied to each child's state to be the initial value of the INPUT field.  */
  205. #define ARGP_KEY_INIT        0x1000003
  206. /* Use after all other keys, including SUCCESS & END.  */
  207. #define ARGP_KEY_FINI        0x1000007
  208. /* Passed in when parsing has successfully been completed (even if there are
  209.    still arguments remaining).  */
  210. #define ARGP_KEY_SUCCESS    0x1000004
  211. /* Passed in if an error occurs.  */
  212. #define ARGP_KEY_ERROR        0x1000005
  213.  
  214. /* An argp structure contains a set of options declarations, a function to
  215.    deal with parsing one, documentation string, a possible vector of child
  216.    argp's, and perhaps a function to filter help output.  When actually
  217.    parsing options, getopt is called with the union of all the argp
  218.    structures chained together through their CHILD pointers, with conflicts
  219.    being resolved in favor of the first occurrence in the chain.  */
  220. struct argp
  221. {
  222.   /* An array of argp_option structures, terminated by an entry with both
  223.      NAME and KEY having a value of 0.  */
  224.   __const struct argp_option *options;
  225.  
  226.   /* What to do with an option from this structure.  KEY is the key
  227.      associated with the option, and ARG is any associated argument (NULL if
  228.      none was supplied).  If KEY isn't understood, ARGP_ERR_UNKNOWN should be
  229.      returned.  If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
  230.      parsing is stopped immediately, and that value is returned from
  231.      argp_parse().  For special (non-user-supplied) values of KEY, see the
  232.      ARGP_KEY_ definitions below.  */
  233.   argp_parser_t parser;
  234.  
  235.   /* A string describing what other arguments are wanted by this program.  It
  236.      is only used by argp_usage to print the `Usage:' message.  If it
  237.      contains newlines, the strings separated by them are considered
  238.      alternative usage patterns, and printed on separate lines (lines after
  239.      the first are prefix by `  or: ' instead of `Usage:').  */
  240.   __const char *args_doc;
  241.  
  242.   /* If non-NULL, a string containing extra text to be printed before and
  243.      after the options in a long help message (separated by a vertical tab
  244.      `\v' character).  */
  245.   __const char *doc;
  246.  
  247.   /* A vector of argp_children structures, terminated by a member with a 0
  248.      argp field, pointing to child argps should be parsed with this one.  Any
  249.      conflicts are resolved in favor of this argp, or early argps in the
  250.      CHILDREN list.  This field is useful if you use libraries that supply
  251.      their own argp structure, which you want to use in conjunction with your
  252.      own.  */
  253.   __const struct argp_child *children;
  254.  
  255.   /* If non-zero, this should be a function to filter the output of help
  256.      messages.  KEY is either a key from an option, in which case TEXT is
  257.      that option's help text, or a special key from the ARGP_KEY_HELP_
  258.      defines, below, describing which other help text TEXT is.  The function
  259.      should return either TEXT, if it should be used as-is, a replacement
  260.      string, which should be malloced, and will be freed by argp, or NULL,
  261.      meaning `print nothing'.  The value for TEXT is *after* any translation
  262.      has been done, so if any of the replacement text also needs translation,
  263.      that should be done by the filter function.  INPUT is either the input
  264.      supplied to argp_parse, or NULL, if argp_help was called directly.  */
  265.   char *(*help_filter) (int __key, __const char *__text, void *__input);
  266.  
  267.   /* If non-zero the strings used in the argp library are translated using
  268.      the domain described by this string.  Otherwise the currently installed
  269.      default domain is used.  */
  270.   const char *argp_domain;
  271. };
  272.  
  273. /* Possible KEY arguments to a help filter function.  */
  274. #define ARGP_KEY_HELP_PRE_DOC    0x2000001 /* Help text preceeding options. */
  275. #define ARGP_KEY_HELP_POST_DOC    0x2000002 /* Help text following options. */
  276. #define ARGP_KEY_HELP_HEADER    0x2000003 /* Option header string. */
  277. #define ARGP_KEY_HELP_EXTRA    0x2000004 /* After all other documentation;
  278.                          TEXT is NULL for this key.  */
  279. /* Explanatory note emitted when duplicate option arguments have been
  280.    suppressed.  */
  281. #define ARGP_KEY_HELP_DUP_ARGS_NOTE 0x2000005
  282. #define ARGP_KEY_HELP_ARGS_DOC    0x2000006 /* Argument doc string.  */
  283.  
  284. /* When an argp has a non-zero CHILDREN field, it should point to a vector of
  285.    argp_child structures, each of which describes a subsidiary argp.  */
  286. struct argp_child
  287. {
  288.   /* The child parser.  */
  289.   __const struct argp *argp;
  290.  
  291.   /* Flags for this child.  */
  292.   int flags;
  293.  
  294.   /* If non-zero, an optional header to be printed in help output before the
  295.      child options.  As a side-effect, a non-zero value forces the child
  296.      options to be grouped together; to achieve this effect without actually
  297.      printing a header string, use a value of "".  */
  298.   __const char *header;
  299.  
  300.   /* Where to group the child options relative to the other (`consolidated')
  301.      options in the parent argp; the values are the same as the GROUP field
  302.      in argp_option structs, but all child-groupings follow parent options at
  303.      a particular group level.  If both this field and HEADER are zero, then
  304.      they aren't grouped at all, but rather merged with the parent options
  305.      (merging the child's grouping levels with the parents).  */
  306.   int group;
  307. };
  308.  
  309. /* Parsing state.  This is provided to parsing functions called by argp,
  310.    which may examine and, as noted, modify fields.  */
  311. struct argp_state
  312. {
  313.   /* The top level ARGP being parsed.  */
  314.   __const struct argp *root_argp;
  315.  
  316.   /* The argument vector being parsed.  May be modified.  */
  317.   int argc;
  318.   char **argv;
  319.  
  320.   /* The index in ARGV of the next arg that to be parsed.  May be modified. */
  321.   int next;
  322.  
  323.   /* The flags supplied to argp_parse.  May be modified.  */
  324.   unsigned flags;
  325.  
  326.   /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the
  327.      number of the current arg, starting at zero, and incremented after each
  328.      such call returns.  At all other times, this is the number of such
  329.      arguments that have been processed.  */
  330.   unsigned arg_num;
  331.  
  332.   /* If non-zero, the index in ARGV of the first argument following a special
  333.      `--' argument (which prevents anything following being interpreted as an
  334.      option).  Only set once argument parsing has proceeded past this point. */
  335.   int quoted;
  336.  
  337.   /* An arbitrary pointer passed in from the user.  */
  338.   void *input;
  339.   /* Values to pass to child parsers.  This vector will be the same length as
  340.      the number of children for the current parser.  */
  341.   void **child_inputs;
  342.  
  343.   /* For the parser's use.  Initialized to 0.  */
  344.   void *hook;
  345.  
  346.   /* The name used when printing messages.  This is initialized to ARGV[0],
  347.      or PROGRAM_INVOCATION_NAME if that is unavailable.  */
  348.   char *name;
  349.  
  350.   /* Streams used when argp prints something.  */
  351.   FILE *err_stream;        /* For errors; initialized to stderr. */
  352.   FILE *out_stream;        /* For information; initialized to stdout. */
  353.  
  354.   void *pstate;            /* Private, for use by argp.  */
  355. };
  356.  
  357. /* Flags for argp_parse (note that the defaults are those that are
  358.    convenient for program command line parsing): */
  359.  
  360. /* Don't ignore the first element of ARGV.  Normally (and always unless
  361.    ARGP_NO_ERRS is set) the first element of the argument vector is
  362.    skipped for option parsing purposes, as it corresponds to the program name
  363.    in a command line.  */
  364. #define ARGP_PARSE_ARGV0  0x01
  365.  
  366. /* Don't print error messages for unknown options to stderr; unless this flag
  367.    is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
  368.    name in the error messages.  This flag implies ARGP_NO_EXIT (on the
  369.    assumption that silent exiting upon errors is bad behaviour).  */
  370. #define ARGP_NO_ERRS    0x02
  371.  
  372. /* Don't parse any non-option args.  Normally non-option args are parsed by
  373.    calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg
  374.    as the value.  Since it's impossible to know which parse function wants to
  375.    handle it, each one is called in turn, until one returns 0 or an error
  376.    other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the
  377.    argp_parse returns prematurely (but with a return value of 0).  If all
  378.    args have been parsed without error, all parsing functions are called one
  379.    last time with a key of ARGP_KEY_END.  This flag needn't normally be set,
  380.    as the normal behavior is to stop parsing as soon as some argument can't
  381.    be handled.  */
  382. #define ARGP_NO_ARGS    0x04
  383.  
  384. /* Parse options and arguments in the same order they occur on the command
  385.    line -- normally they're rearranged so that all options come first. */
  386. #define ARGP_IN_ORDER    0x08
  387.  
  388. /* Don't provide the standard long option --help, which causes usage and
  389.       option help information to be output to stdout, and exit (0) called. */
  390. #define ARGP_NO_HELP    0x10
  391.  
  392. /* Don't exit on errors (they may still result in error messages).  */
  393. #define ARGP_NO_EXIT    0x20
  394.  
  395. /* Use the gnu getopt `long-only' rules for parsing arguments.  */
  396. #define ARGP_LONG_ONLY    0x40
  397.  
  398. /* Turns off any message-printing/exiting options.  */
  399. #define ARGP_SILENT    (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP)
  400.  
  401. /* Parse the options strings in ARGC & ARGV according to the options in ARGP.
  402.    FLAGS is one of the ARGP_ flags above.  If ARG_INDEX is non-NULL, the
  403.    index in ARGV of the first unparsed option is returned in it.  If an
  404.    unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser
  405.    routine returned a non-zero value, it is returned; otherwise 0 is
  406.    returned.  This function may also call exit unless the ARGP_NO_HELP flag
  407.    is set.  INPUT is a pointer to a value to be passed in to the parser.  */
  408. extern error_t argp_parse (__const struct argp *__restrict __argp,
  409.                int __argc, char **__restrict __argv,
  410.                unsigned __flags, int *__restrict __arg_index,
  411.                void *__restrict __input);
  412. extern error_t __argp_parse (__const struct argp *__restrict __argp,
  413.                  int __argc, char **__restrict __argv,
  414.                  unsigned __flags, int *__restrict __arg_index,
  415.                  void *__restrict __input);
  416.  
  417. /* Global variables.  */
  418.  
  419. /* If defined or set by the user program to a non-zero value, then a default
  420.    option --version is added (unless the ARGP_NO_HELP flag is used), which
  421.    will print this string followed by a newline and exit (unless the
  422.    ARGP_NO_EXIT flag is used).  Overridden by ARGP_PROGRAM_VERSION_HOOK.  */
  423. extern __const char *argp_program_version;
  424.  
  425. /* If defined or set by the user program to a non-zero value, then a default
  426.    option --version is added (unless the ARGP_NO_HELP flag is used), which
  427.    calls this function with a stream to print the version to and a pointer to
  428.    the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
  429.    used).  This variable takes precedent over ARGP_PROGRAM_VERSION.  */
  430. extern void (*argp_program_version_hook) (FILE *__restrict __stream,
  431.                       struct argp_state *__restrict
  432.                       __state);
  433.  
  434. /* If defined or set by the user program, it should point to string that is
  435.    the bug-reporting address for the program.  It will be printed by
  436.    argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
  437.    standard help messages), embedded in a sentence that says something like
  438.    `Report bugs to ADDR.'.  */
  439. extern __const char *argp_program_bug_address;
  440.  
  441. /* The exit status that argp will use when exiting due to a parsing error.
  442.    If not defined or set by the user program, this defaults to EX_USAGE from
  443.    <sysexits.h>.  */
  444. extern error_t argp_err_exit_status;
  445.  
  446. /* Flags for argp_help.  */
  447. #define ARGP_HELP_USAGE        0x01 /* a Usage: message. */
  448. #define ARGP_HELP_SHORT_USAGE    0x02 /*  " but don't actually print options. */
  449. #define ARGP_HELP_SEE        0x04 /* a `Try ... for more help' message. */
  450. #define ARGP_HELP_LONG        0x08 /* a long help message. */
  451. #define ARGP_HELP_PRE_DOC    0x10 /* doc string preceding long help.  */
  452. #define ARGP_HELP_POST_DOC    0x20 /* doc string following long help.  */
  453. #define ARGP_HELP_DOC        (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
  454. #define ARGP_HELP_BUG_ADDR    0x40 /* bug report address */
  455. #define ARGP_HELP_LONG_ONLY    0x80 /* modify output appropriately to
  456.                     reflect ARGP_LONG_ONLY mode.  */
  457.  
  458. /* These ARGP_HELP flags are only understood by argp_state_help.  */
  459. #define ARGP_HELP_EXIT_ERR    0x100 /* Call exit(1) instead of returning.  */
  460. #define ARGP_HELP_EXIT_OK    0x200 /* Call exit(0) instead of returning.  */
  461.  
  462. /* The standard thing to do after a program command line parsing error, if an
  463.    error message has already been printed.  */
  464. #define ARGP_HELP_STD_ERR \
  465.   (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
  466. /* The standard thing to do after a program command line parsing error, if no
  467.    more specific error message has been printed.  */
  468. #define ARGP_HELP_STD_USAGE \
  469.   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
  470. /* The standard thing to do in response to a --help option.  */
  471. #define ARGP_HELP_STD_HELP \
  472.   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
  473.    | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
  474.  
  475. /* Output a usage message for ARGP to STREAM.  FLAGS are from the set
  476.    ARGP_HELP_*.  */
  477. extern void argp_help (__const struct argp *__restrict __argp,
  478.                FILE *__restrict __stream,
  479.                unsigned __flags, char *__restrict __name);
  480. extern void __argp_help (__const struct argp *__restrict __argp,
  481.              FILE *__restrict __stream, unsigned __flags,
  482.              char *__name);
  483.  
  484. /* The following routines are intended to be called from within an argp
  485.    parsing routine (thus taking an argp_state structure as the first
  486.    argument).  They may or may not print an error message and exit, depending
  487.    on the flags in STATE -- in any case, the caller should be prepared for
  488.    them *not* to exit, and should return an appropiate error after calling
  489.    them.  [argp_usage & argp_error should probably be called argp_state_...,
  490.    but they're used often enough that they should be short]  */
  491.  
  492. /* Output, if appropriate, a usage message for STATE to STREAM.  FLAGS are
  493.    from the set ARGP_HELP_*.  */
  494. extern void argp_state_help (__const struct argp_state *__restrict __state,
  495.                  FILE *__restrict __stream,
  496.                  unsigned int __flags);
  497. extern void __argp_state_help (__const struct argp_state *__restrict __state,
  498.                    FILE *__restrict __stream,
  499.                    unsigned int __flags);
  500.  
  501. /* Possibly output the standard usage message for ARGP to stderr and exit.  */
  502. extern void argp_usage (__const struct argp_state *__state);
  503. extern void __argp_usage (__const struct argp_state *__state);
  504.  
  505. /* If appropriate, print the printf string FMT and following args, preceded
  506.    by the program name and `:', to stderr, and followed by a `Try ... --help'
  507.    message, then exit (1).  */
  508. extern void argp_error (__const struct argp_state *__restrict __state,
  509.             __const char *__restrict __fmt, ...)
  510.      __attribute__ ((__format__ (__printf__, 2, 3)));
  511. extern void __argp_error (__const struct argp_state *__restrict __state,
  512.               __const char *__restrict __fmt, ...)
  513.      __attribute__ ((__format__ (__printf__, 2, 3)));
  514.  
  515. /* Similar to the standard gnu error-reporting function error(), but will
  516.    respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
  517.    to STATE->err_stream.  This is useful for argument parsing code that is
  518.    shared between program startup (when exiting is desired) and runtime
  519.    option parsing (when typically an error code is returned instead).  The
  520.    difference between this function and argp_error is that the latter is for
  521.    *parsing errors*, and the former is for other problems that occur during
  522.    parsing but don't reflect a (syntactic) problem with the input.  */
  523. extern void argp_failure (__const struct argp_state *__restrict __state,
  524.               int __status, int __errnum,
  525.               __const char *__restrict __fmt, ...)
  526.      __attribute__ ((__format__ (__printf__, 4, 5)));
  527. extern void __argp_failure (__const struct argp_state *__restrict __state,
  528.                 int __status, int __errnum,
  529.                 __const char *__restrict __fmt, ...)
  530.      __attribute__ ((__format__ (__printf__, 4, 5)));
  531.  
  532. /* Returns true if the option OPT is a valid short option.  */
  533. extern int _option_is_short (__const struct argp_option *__opt) __THROW;
  534. extern int __option_is_short (__const struct argp_option *__opt) __THROW;
  535.  
  536. /* Returns true if the option OPT is in fact the last (unused) entry in an
  537.    options array.  */
  538. extern int _option_is_end (__const struct argp_option *__opt) __THROW;
  539. extern int __option_is_end (__const struct argp_option *__opt) __THROW;
  540.  
  541. /* Return the input field for ARGP in the parser corresponding to STATE; used
  542.    by the help routines.  */
  543. extern void *_argp_input (__const struct argp *__restrict __argp,
  544.               __const struct argp_state *__restrict __state)
  545.      __THROW;
  546. extern void *__argp_input (__const struct argp *__restrict __argp,
  547.                __const struct argp_state *__restrict __state)
  548.      __THROW;
  549.  
  550. #ifdef __USE_EXTERN_INLINES
  551.  
  552. # if !_LIBC
  553. #  define __argp_usage argp_usage
  554. #  define __argp_state_help argp_state_help
  555. #  define __option_is_short _option_is_short
  556. #  define __option_is_end _option_is_end
  557. # endif
  558.  
  559. # ifndef ARGP_EI
  560. #  define ARGP_EI extern __inline__
  561. # endif
  562.  
  563. ARGP_EI void
  564. __NTH (__argp_usage (__const struct argp_state *__state))
  565. {
  566.   __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
  567. }
  568.  
  569. ARGP_EI int
  570. __NTH (__option_is_short (__const struct argp_option *__opt))
  571. {
  572.   if (__opt->flags & OPTION_DOC)
  573.     return 0;
  574.   else
  575.     {
  576.       int __key = __opt->key;
  577.       return __key > 0 && isprint (__key);
  578.     }
  579. }
  580.  
  581. ARGP_EI int
  582. __NTH (__option_is_end (__const struct argp_option *__opt))
  583. {
  584.   return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
  585. }
  586.  
  587. # if !_LIBC
  588. #  undef __argp_usage
  589. #  undef __argp_state_help
  590. #  undef __option_is_short
  591. #  undef __option_is_end
  592. # endif
  593. #endif /* Use extern inlines.  */
  594.  
  595. #ifdef  __cplusplus
  596. }
  597. #endif
  598.  
  599. #endif /* argp.h */
  600.